Cancel Authorization
Cancelamento de uma autorização
Use este endpoint para cancelar uma autorização de Pix Automático.
Requisição
POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:cancellationIdentifier/cancellations'
Cabeçalhos
| Nome | Descrição |
|---|---|
| Authorization | Obrigatório. Chave da API |
Parâmetros de Path
| Nome | Tipo | Descrição |
|---|---|---|
| cancellationIdentifier | string | Obrigatório. Identificador do cancelamento |
Atributos do Corpo
| Nome | Tipo | Descrição |
|---|---|---|
| cancellationReason | enum | Motivo do cancelamento. Consulte a tabela abaixo para as opções válidas. |
Motivos de cancelamento
Abaixo está a lista de motivos de cancelamento e seus significados. Eles devem ser enviados como string no campo cancellationReason.
| Motivo | Descrição |
|---|---|
ACCOUNT_CLOSED | A conta do pagador ou do recebedor foi encerrada |
COMPANY_CLOSED | A empresa recebedora foi encerrada |
PAYER_DECEASED | O pagador faleceu |
REQUEST_ERROR_BY_RECEIVER | Erro na solicitação do recebedor ou participante |
FRAUD_SUSPECTED | Suspeita de fraude |
DUPLICATE_CONFIRMATION | Confirmação duplicada (ex.: QR Code) |
REQUESTED_BY_PAYEE | Solicitado pelo recebedor |
REQUESTED_BY_PAYER | Solicitado pelo pagador |
NO_RESPONSE_TO_PAIN009 | Sem resposta ao pain.009 dentro do prazo regulatório |
Corpo
{
"cancellationReason": "REQUESTED_BY_PAYEE"
}
Resposta
O status code 200 indica sucesso na consulta.
Motivos de cancelamento
Abaixo está a lista de motivos de cancelamento e seus significados que podem ser retornados no campo CancellationReason.
| Motivo | Descrição |
|---|---|
ACCOUNT_CLOSED | A conta do pagador ou do recebedor foi encerrada |
COMPANY_CLOSED | A empresa recebedora foi encerrada |
PAYER_DECEASED | O pagador faleceu |
REQUEST_ERROR_BY_RECEIVER | Erro na solicitação do recebedor ou participante |
FRAUD_SUSPECTED | Suspeita de fraude |
DUPLICATE_CONFIRMATION | Confirmação duplicada (ex.: QR Code) |
REQUESTED_BY_PAYEE | Solicitado pelo recebedor |
REQUESTED_BY_PAYER | Solicitado pelo pagador |
NO_RESPONSE_TO_PAIN009 | Sem resposta ao pain.009 dentro do prazo regulatório |
Status do cancelamento
Abaixo está a lista de status que podem ser retornados no campo CancellationStatus.
| Status | Descrição |
|---|---|
ACCEPTED | Cancelamento aceito |
REJECTED | Cancelamento rejeitado |
Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:
{
"recurrenceId": "RR3822485720251212i0jYqQr7g5n",
"requestedAt": "2026-01-16T17:52:54.112"
}
Consultar cancelamento de autorização
Este endpoint consulta um cancelamento de autorização.
Requisição
GET 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:recurrenceId/cancellations/:cancellationId'
Cabeçalhos
| Nome | Descrição |
|---|---|
| Authorization | Obrigatório. Chave da API |
Parâmetros de Path
| Nome | Tipo | Descrição |
|---|---|---|
| recurrenceId | string | Obrigatório. Identificador da autorização |
| cancellationId | string | Obrigatório. Identificador do cancelamento |
Resposta
O status code 200 indica sucesso na consulta.
Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:
{
"RecurrenceId": "RR0435879820240605njua7shf40o",
"CancellationId": "IC0435879820240605bcdb1fhn43a",
"StatusDateTime": "2024-09-17T10:15:00.000Z",
"RequesterPersonType": "NATURAL",
"RequesterDocument": "77379362038",
"CancellationReason": "FRAUD_SUSPECTED",
"CancellationAt": "2024-09-17T10:10:06.101Z",
"CancellationStatus": "ACCEPTED",
"ErrorCode": null,
"ErrorDescription": null
}